UseCacheReturnType

---

import { UseCacheReturnType } from "@hyper-fetch/react"

Description

Defined in hooks/use-cache/use-cache.types.ts:27

Preview

type UseCacheReturnType<T> = UseTrackedStateType<T> & UseTrackedStateActions<T> & { onCacheChange: (callback: OnFinishedCallbackType<T>) => void; onCacheError: (callback: OnErrorCallbackType<T>) => void; onCacheSuccess: (callback: OnSuccessCallbackType<T>) => void; revalidate: (invalidateKey?: string | RegExp | CommandInstance) => void };

Structure

{
  data: null | T extends Command<infer D, any, any, any, any, any, any, any, any, any, any> ? D : never;
  error: null | T extends Command<any, any, any, infer G, infer L, any, any, any, any, any, any> ? \G\ | \L\ : never;
  loading: boolean;
  retries: number;
  status: null | number;
  timestamp: null | Date;
  setData: (data: ExtractResponse<T>, emitToCache?: boolean) => void;
  setError: (error: ExtractError<T>, emitToCache?: boolean) => void;
  setLoading: (loading: boolean, emitToHooks?: boolean) => void;
  setRetries: (retries: number, emitToCache?: boolean) => void;
  setStatus: (status: number | null, emitToCache?: boolean) => void;
  setTimestamp: (timestamp: Date, emitToCache?: boolean) => void;
  onCacheChange: (callback: OnFinishedCallbackType<T>) => void;
  onCacheError: (callback: OnErrorCallbackType<T>) => void;
  onCacheSuccess: (callback: OnSuccessCallbackType<T>) => void;
  revalidate: (invalidateKey?: string | RegExp | CommandInstance) => void;
}